Usage Consumption Biz API
CWP UsageConsumptionReport
GET /usageConsumptionReport
Key considerations for CWP (Panama Market)
- for Panama prepaid, data will be retrieved from Ericsson with serviceNumber/phoneNumber as input.
- for Panama postpaid, data will be retrieved from liberate with accountNumber and ServiceNumber/phoneNumber as input.
- To retrieve data from Liberate/Ericsson. The service number need to be provided without country code and BU code.
For sample responses refer below examples:
- PA Liberate response
- PA Ericsson response
Request
This section defines all the possible data structures sent by the client when consuming the method.
URL
http://[localhost]:[port]/tmf-api/usageConsumption/v3/{businessId}/usageConsumptionReportURL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (PA, TT, BB, JM etc.) identifying the business unit | Y |
Header
| name | value | description | required |
|---|---|---|---|
| client_id | string | This Client ID must be valid and generate by Operation Team. | Y |
| client_secret | string | This Client Secret must be valid and provisioned by Operation Team. | Y |
| X-Correlation-ID | string | This is a unique identifier for the current call chain that can be used to tie together log entries on multiple layer. Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b | N |
Query Param
| name | type | description | required |
|---|---|---|---|
| relatedParty.id | string | unique identifier of the account. This is mandatory when BSS is liberate and searchCriteria.service.@type is POSTPAID | cond Y |
| usageConsumption.logicalResource.id | string | unique identifier EX:ServiceNum | Y |
| searchCriteria.service.@type | String | This is the type Of service. It can be one of [PREPAID, POSTPAID, FIXED] | Y |